﻿<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Rainbow ReadMe</title>
</head>
<body>
<h1>Release Notes - Okapi Olifant @version@, @date@</h1>
<ul>
	<li><a href="#overview">Overview</a></li>
	<li><a href="#SetupWindows">Windows Platform</a></li>
	<li><a href="#SetupLinux">Linux Platforms</a></li>
	<li><a href="#SetupMac">Macintosh Platform</a></li>
	<li><a href="#Support">Support</a></li>
</ul>
<hr>
<h2><a name="overview"></a>Overview</h2>
<p>The <b>okapi-olifant</b> distribution contains <b>
<a href="http://www.opentag.com/okapi/wiki/index.php?title=Olifant">Olifant</a></b>, a cross-platform application to create and maintain 
translation memory repositories. It allows you to work primarily with
<a href="http://www.opentag.com/okapi/wiki/index.php?title=TMX">TMX files</a> 
but can also work with other formats such such as PO,
<a href="http://www.opentag.com/okapi/wiki/index.php?title=XLIFF">XLIFF</a>, and 
other translation formats.</p>
<p>
The source code is available in the
<a href="http://code.google.com/p/okapi-olifant/"><b>okapi-olifant</b> Google 
Code project</a>.</p>
<p>For a list of changes since the previous release, 
please see the <a href="changes.html">Changes Log document</a>.</p>
<p>The latest version of the help is available on-line on the <a href="http://www.opentag.com/okapi/wiki">Okapi Framework Web site</a>.</p>
<hr>
<h2><a name="SetupWindows"></a>Windows Platform</h2>
<h3>Requirements</h3>
<p>In order to run Olifant on Windows you must have a running installation of Java&nbsp;1.6 or 
later. Sun Java, or an OpenJDK VM is recommended.</p>
<h3>Installation</h3>
<p>To install Olifant on Windows (32- and 64-bit):</p>
<ol>
	<li>Download the ZIP file of the Windows distribution.</li>
	<li>Unzip the file on any location, we recommend <code>C:\Program Files\Olifant</code>.</li>
</ol>
<p>To run Olifant: simply double-click on the <code>olifant.exe</code> file in the main folder.</p>
<p>You can also run the application with the following command line (assuming it 
has been unzipped in the recommended folder):</p>
<pre>C:\&gt;javaw -jar C:\Program Files\Olifant\lib\rainbow.jar</pre>
<h3>Uninstallation</h3>
<p>To uninstall:</p>
<ol>
	<li>Olifant runs independently of Windows, so to uninstall it you can simply delete the folder where you have installed it. 
There is no Registry information to remove.</li>
	<li>If you want you can also remove the 
file where the user preferences are saved. It is located in the Home folder of 
the user and called <code>.Olifant</code>.</li>
</ol>

<hr>
<h2><a name="SetupLinux"></a>Linux Platforms</h2>
<h4>Requirements</h4>
<p>In order to run Olifant on Linux you must have a running installation of Java&nbsp;1.6 or 
later. Sun Java, or an OpenJDK VM is recommended.</p>
<h3>Installation</h3>
<p>To install Olifant on Linux (32- and 64-bit):</p>
<ol>
	<li>Download the ZIP file of the Linux distribution you need (there is one 
	for 32-bit and one for 64-bit).</li>
	<li>Extract the file on any location. Make sure to preserve the full paths 
	when extracting.</li>
</ol>
<p>To runOlifant: simply double-click on the <code>olifant.sh</code> file in the 
main directory.</p>
<p>You can also run the application from the command line (assuming Olifant is 
installed in <code>\home\archie\olifant</code>):</p>
<pre>archie@archie:~&gt;java -jar okapi/lib/olifant.jar</pre>
<h3>Uninstallation</h3>
<p>To uninstall:</p>
<ol>
	<li>Delete the directory where Olifant is installed.</li>
	<li>If you want, you can also remove the 
file where the user preferences are saved. It is located in the Home folder of 
the user and called <code>.Olifant</code>.</li>
</ol>

<hr>
<h2><a name="SetupMac"></a>Macintosh Platform</h2>
<h3>Requirements</h3>
<p>In order to run Olifant on Macintsoh you must have Java 1.6 
installed. Note that Apple does not provide Java 1.6 for all versions and architectures of 
the Mac. </p>
<ul>
	<li>If you have a 32-bit machine, you can run Java 1.6 only on Mac OS X 10.6 
	(Snow Leopard) using the 32-bit mode.</li>
	<li>If you have a 64-bit machine, you can run Java 1.6 on either Mac OS X 
	10.5 (Leopard) or Mac OS X 10.6 (Snow Leopard) using the 
	64-bit mode. On Mac OX 10.7 (Lion) there is no pre-installed Java Runtime, 
	but it can be installed easily.</li>
</ul>
<h3>Installation</h3>
<p>To install Olifant on Macintosh (32- and 64-bit):</p>
<ol>
	<li>Download the ZIP file of the Macintosh distribution you need (See above).</li>
	<li>Extract the ZIP file on any location. For example <code>
	/Users/admin/Desktop/Olifant</code>.</li>
</ol>
<p>To run Olifant:</p>
<ol>
	<li>The main directory of the distribution contains a <code>Olifant</code> 
	application bundle (Olifant.app): simply double-click on it.</li>
	<li>If you run the application for the first time since you downloaded it, 
	you may be prompted to confirm you want to run it.</li>
</ol>
<p>You can modify the shell file <code>olifant.sh</code> that is in the <code>
/Contents/MacOS</code> folder of the application bundle to fit your own parameters. In all cases you <b>MUST</b> specify the <code>-XstartOnFirstThread</code> option or the 
application may 
not work properly. You can make sure to run the Java VM in a specific mode using 
the <code>-d32</code> and <code>-d64</code> flags.</p>
<h3>Uninstallation</h3>
<p>To uninstall:</p>
<ol>
	<li>Delete the directory where Olifant is installed.</li>
	<li>If you want, you can also remove the 
file where the user preferences are saved. It is located in the Home folder of 
the user and called <code>.Olifant</code>.</li>
</ol>

<hr>
<h2><a name="Support"></a>Support</h2>
<p>If you have questions, suggestions or bug to report, you can do this 
different ways:</p>
<ul>
	<li>Use the <cite>Send Feedback</cite> command in the <cite>Help</cite> menu 
	of Olifant.</li>
	<li>Read and post notes in the
	<a target="_blank" href="http://tech.groups.yahoo.com/group/okapitools/">Okapi Tools users group</a> (you need to be registered member to post, but 
	not to read).</li>
</ul>
<p>&nbsp;</p>
</body>
</html>